Description

This PR closes #1055 and, in the process, updates zio-json to the Scala Native 0.5.x series (necessary because this requires multiple PRs to Magnolia and Magnolia is already on the 0.5.x series). Since the move to the Scala Native 0.5.x series was a small ecosystem change, it required most dependencies to be updated to the latest versions. It also required a slight downgrade to the 7.2.x series in the scalaz dependency, since the 7.3.x series does not yet support Scala Native.

The solution does the following things:

1. For each default parameter, it computes two values at build time. If the values are the same, the default parameter will be memoized. If the values are different, the default value will be computed during json parsing.

2. The above provides out-of-the-box support for random generators which are always random (like java.util.UUID). However, random time-based generators are not always random, since they can be called at the same time or near enough to the same time to render the same result twice. Therefore, this solution does not memoize default values of any class that extends java.time.temporal.Temporal - default values for all of the following will be computed during json parsing:

   • HijrahDate
   • Instant,
   • JapaneseDate
   • LocalDate
   • LocalDateTime
   • LocalTime
   • MinguoDate
   • OffsetDateTime
   • OffsetTime
   • ThaiBuddhistDate
   • Year
   • YearMonth
   • ZonedDateTime

3. For all random generators that are not truly random and are outside of the above classes, this solution introduces a @jsonAlwaysEvaluateDefault annotation so that users can manually force evaluation of the default parameter every time json is parsed (especially relevant for timestamp values coming from 3rd party libs, e.g. org.joda.time).

The result is that users can implement the following case class and expect the results for each parameter as described in the comments:

final case class DynamicDefaultExample (
    @jsonAlwaysEvaluateDefault
    jodaInstant: joda.time.Instant = joda.time.Instant.now(), //Will always be fresh, due to annotation
    sometimesMemoizedJodaInstant: joda.time.Instant = joda.time.Instant.now(), //Will be flaky. Without @jsonAlwaysEvaluateDefault, this will sometimes be parsed every time; sometimes it will be memoized.
    javaInstant: java.time.Instant = java.time.Instant.now(), //will always be fresh, with or without annotation
    uuid: UUID = UUID.randomUUID(), //will always be fresh, with or without annotation
    random: Double = scala.math.random() //will always be fresh, with or without annotation
)

External dependencies

Several external dependencies need to be closed before this will build in Github Actions:

1. The core ZIO libraries need to be upgraded to Scala Native 0.5.x. This can be started once upstream dependencies are upgraded. Publish for Scala native 0.5 zio#8786
2. The scala-java-time lib needs to be upgraded to Scala Native 0.5.x. Scala Native 0.5.x cquiroz/scala-java-time#508
3. One PR needs to be merged into the Magnolia Scala 2.x series. [scala2] feat: adding on-demand default evaluation softwaremill/magnolia#533
4. One PR needs to be merged into the Magnolia Scala 3.x series. feat: adding on-demand default evaluation softwaremill/magnolia#534

/claim #1055